home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / x2t11.zip / ATX2TXT.DOC < prev    next >
Text File  |  1991-09-28  |  9KB  |  172 lines
  1.  
  2. AtX2Txt - Version: 1.1 - Compiled: 09-28-91 01:10
  3.           Convert files with PCBoard's @ variables and colors to text.
  4. ══════════════════════════════════════════════════════════════════════════════
  5.  
  6. ┌───────────────────┐
  7. │ ABOUT ATX2TXT ... │
  8. └───────────────────┘
  9.  
  10.         A rather simple program to read files which have been created with
  11. either PCBoard's color codes or @ variables and rewrite them as a simple text
  12. file, ready for viewing by anyone, without PCBoard.  The reason for it is my
  13. desire to make bulletins and other files available to my callers while I do
  14. wish to keep using the various codes for on-line display.
  15.  
  16.         The reason for writing this program (as opposed to using one of the
  17. existing ones) is that I could not find one that did all I wanted.  With all
  18. that said, let's see what this one will do for you.
  19.  
  20. AtX2Txt will    1. Use a simple text file where you can list all the files you
  21.                    wish to process each time;
  22.                 2. It allows you to specify a new destination file name. The
  23.                    original is never touched;
  24.                 3. It allows you to specify an optional ZIP file name to place
  25.                    the new text file into, presumably for downloading;
  26.                 4. It will not process files which have not changed since last
  27.                    processed by AtX2Txt;
  28.                 5. It will remove all PCBoard @X color codes;
  29.                 6. It will remove some of the PCBoard @-variables,
  30.                    specifically, QON, QOFF, MORE, PAUSE, PON, POFF, CLS,
  31.                    DATAPHONE and HOMEPHONE;  More may be added in the future;
  32.                 7. It will replace some of the PCBoard @-variables,
  33.                    specifically, SYSTIME, SYSDATE and LASTDATEON will be
  34.                    replaced by the system time or date of creation of the text
  35.                    file;
  36.                 8. There is no limit on the number files which may be processed
  37.                    nor on the number of ZIP files they are to placed into;
  38.  
  39.  
  40. ┌────────────────────────┐
  41. │ CAVEAT - READ THIS ... │
  42. └────────────────────────┘
  43.  
  44.         This program is admittedly not for everyone.  There are a lot of others
  45. out there which will do similar tasks.  AtX2Txt is distributed as FREEWARE,
  46. that is no registration (reads money) is required for it.  If it suits your
  47. needs, enjoy.  No charges may be imposed by anyone for AtX2Txt of any sort
  48. beyond reasonable reproduction costs.
  49.  
  50.         The program "stamps" all text files created at the end.  It records the
  51. date and time the original was last modified (based on the file's date/time).
  52. It also records the program's name, version and where it may be obtained.  If
  53. you do not wish this information recorded in the text files created I suggest
  54. you do not use this program.  Should a commercial version ever be published
  55. this "stamp" will be optional, of course.
  56.  
  57.  
  58. ┌─────────────────────────────────┐
  59. │ SETTING UP, GETTING STARTED ... │
  60. └─────────────────────────────────┘
  61.  
  62. OK, with all that said, let's see how you can set this up quickly to get
  63. started..
  64.  
  65.         You need to create a configuration file, which is a simple text file,
  66. to tell the program what you want it to do.  I will use the name ATX2TXT.CFG i
  67. nthis document although the name can be anything you'd like (see command line
  68. options below).  Each line in this file represents one task to do and you may
  69. use any number of lines you wish.
  70.  
  71.         Each line is made up of 5 parts which I will call "variables" for lack
  72. of a better term.  Variables *MUST* be separated by the vertical bar character
  73. (|) at all times.  Their usage, from left to right is as follows:
  74.  
  75. Variable 1:  This is the name of the original file to duplicate, presumably the
  76.              one which contains the PCBoard codes.  This variable must be a
  77.              *complete* file specification for the file to be located.  No
  78.              searching will be perfomed in order to locate the file; it either
  79.              exists as specified or not.  This file is opened for read only,
  80.              deny none if running on a network.
  81.  
  82. Variable 2:  This is the name of the textfile you wish to create from the above
  83.              input file.  If the file exists it will be overwritten without
  84.              warning!   This variable must be a *complete* file specification
  85.              for the file to be located.  No searching will be perfomed in
  86.              order to locate the file for a possible overwrite; it either
  87.              exists as specified or not.  This file is opened for write only,
  88.              deny all if running on a network.
  89.  
  90. Variable 3:  This is an optional variable.  If you do not wish to use it
  91.              simply type another vertical bar without an entry.  If present,
  92.              variable 3 specifies the name of the ZIP file within which the
  93.              text file (as defined in variable 2) should be placed.  This
  94.              variable must be a *complete* file specification for the file
  95.              to be located.  No searching will be perfomed in order to locate
  96.              the file; it either exists as specified or not.  If it does not
  97.              exist, PKZIP will create it for you.  This file is not opened by
  98.              AtX2Txt, it is used only by PKZIP.EXE.  NOTE that if the created
  99.              text file is to be placed in a ZIP through this variable it will
  100.              be DELETED after PKZIP is finished.
  101.  
  102. Variable 4:  This one is maintained by the program itself to record the last
  103.              date your original input file was updated.  Whenever you create a
  104.              new line in the configuration file be sure to enter six zeros for
  105.              this field to assure that the file will be processed with the next
  106.              run of the program.
  107.  
  108. Variable 5:  This one is maintained by the program itself to record the last
  109.              time your original input file was updated.  Whenever you create a
  110.              new line in the configuration file be sure to enter six zeros for
  111.              this field to assure that the file will be processed with the next
  112.              run of the program.
  113.  
  114. Your configuration file should look something like this:
  115.  
  116. J:\PCB\BLT60 | G:\TEMP\BLT60.TXT | G:\TEMP\EXECBLTS.ZIP | 910723 | 183204
  117. J:\PCB\BLT61 | G:\TEMP\BLT61.TXT |                      | 910723 | 183204
  118. J:\PCB\BLT32 | G:\TEMP\INFO.TXT  | G:\TEMP\EXECBLTS.ZIP | 000000 | 000000
  119.  
  120. The spacing is unimportant as is the case the data is typed in.  Notice, that
  121. in the above example BLT60 and BLT32 will be ZIPped while BLT61 will not be.
  122. Also, BLT32 is a new addition to the list, so the date and time are entered as
  123. zeros to assure processing.
  124.  
  125.  
  126. ┌──────────────────────────┐
  127. │ COMMAND LINE OPTIONS ... │
  128. └──────────────────────────┘
  129.  
  130.         Not a lot else to cover here but a few additional notes are in order.
  131. The command line has very few options.  You can specify the name of the
  132. configuration file if desired as "ATX2TXT C:MYCONFIG.XXX".  If it is not
  133. specified, the program will assume that the name is ATX2TXT.CFG and that it is
  134. located in the CURRENT directory!  No searching will be performed for the file.
  135. If you wish to keep the file in a location other than the current one (when the
  136. program runs) you must specify this on the command line, including drive,
  137. directory and file name!
  138.  
  139.         There are only 2 additional command line options available.  You can
  140. specify "/I" to ignore file dating.  If this option is used it must be the last
  141. item on the command line (in other words, it must follow the configuration name
  142. if that is to be specified).  With this switch, the program will process ALL
  143. files listed in the configuration, regardless of their last update.
  144.  
  145.         The "/REGISTER" option is reserved for beta testers only.
  146.  
  147.  
  148. ┌─────────────────┐
  149. │ THE DISPLAY ... │
  150. └─────────────────┘
  151.  
  152.         The display will show you the progress of of the program.  Since I get
  153. rather frustrated watching a program with no screen activity (do you ever
  154. wonder if the sucker is hung?) whenever a file is being processed there is a
  155. "wheel" spinning on the right side of the line.
  156.  
  157.         If the file contained recognized @ variables, a red diamond will show
  158. up immediately preceeding the file specification.
  159.  
  160.         Only the last six lines will be displayed at any given time.
  161.  
  162.  
  163. ┌──────────────────────┐
  164. │ REVISION HISTORY ... │
  165. └──────────────────────┘
  166.  
  167.         Version 1.0     - Not released, internal use only.
  168.         Version 1.1     - September 28, 1991 - 01:10
  169.                           First official release of the program.
  170.  
  171.  
  172.